VPN-6252: Add Daemon Documentation #9741
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
strseb
reviewed
Jul 23, 2024
docs/Components/daemon.md
Outdated
|
|
||
| ### Android daemon??? | ||
|
|
||
| TODO: How does Android work, exactly? |
There was a problem hiding this comment.
The Daemon is an Android Service communicating using Bindings with the Client (or widgets). Unlike "standard" android guidelines, it's explicitly a 2nd process.
The protocol is similar to the desktop daemons as we exchange json blobs but the format on the wire is {requestType:int,data:json} (...we could actually think about using the desktop protocol at some point)
To activate the daemon will request a raw handle of a TUN device using Android's VPN API. It load's wireguard-go into it's process and calls into wg-go with the handle and the config, which will then spawn a goroutine handling traffic.
strseb
approved these changes
Jul 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
We have a need to better document how the daemon works, why we need it, and how it is expected to recover in the event of a crash. This PR should add a new document at
docs/Components/daemon.mdwith the desired details.Reference
JIRA Issue: VPN-6252
Checklist